更改认证类型
如果您的 API 的认证方法发生变化,您需要更新 Zapier 用于认证用户帐户的方法。
对用户的影响
更改集成中的认证类型(例如,Basic Auth、API Key 或 OAuth)被视为破坏性变更。值得注意的是,进行迁移是不可行的,因为如果迁移,所有现有的已连接帐户都会停止工作。用户需要重新连接您的集成,并在每个 Zap 中手动进行修改。
但是,如果您的集成满足以下条件,您可以使用联系表格来请求支持,以帮助在不同认证类型之间迁移已连接帐户:
- 您的集成是公开的。
- 您有一个 API 端点,或者可以通过其他编程方式,将旧类型的数据(例如,API Key)交换为新类型的数据(例如,OAuth2 访问和刷新令牌)。
- 集成动作所使用的 API 端点能够同时支持旧认证类型和新认证类型,至少在未来几个月内保持兼容,直到旧类型可能被弃用。
- 例如,将 API Key 交换为 OAuth2 访问令牌时,不会立即使 API Key 失效,从而不会破坏其他可能仍在使用的已连接帐户。
最佳实践
创建新版本
管理现有用户
- 如果使用现有认证方法的用户可以继续保留他们的连接,建议让他们继续使用旧版本。
- 但是,对于新 Zap,他们将被提示创建新的连接,因为只有推广版本在基于名称的应用程序搜索中可用。
弃用旧认证方案
- 如果现有的认证方法将在未来停止工作,则需要进行弃用。
- 请注意,这可能会对我们共同的用户造成重大干扰,因此需要仔细考虑。
注意:此方法不适用于在旧版 Web 构建器中构建的应用。要更新认证,您需要更新所有触发器、动作和搜索;因为在新构建器中删除并重新添加认证方法,将与旧版 Web 构建器中创建的现有触发器、动作和搜索不兼容。